文档审核增强版API

接入指引

1. 注册阿里云账号：立即注册，按照操作提示完成账号注册。

2. 开通内容安全按量付费：请确保已开通服务，具体操作，请参见开通服务。开通不收费，接口接入使用后系统会按使用量自动出账。您也可以购买按量抵扣资源包，资源包相较于后付费存在一定阶梯抵扣，适合使用量级可预期和较大的用户，具体信息，请参见购买按量抵扣资源包。

3. 创建AccessKey：请确保您已通过RAM创建AccessKey，具体操作，请参见创建AccessKey。如果您使用的是RAM用户（子账号）AccessKey，您需要通过阿里云账号（主账号）给RAM用户赋予AliyunYundunGreenWebFullAccess权限，具体操作，请参见RAM授权。

4. 开发接入：推荐使用SDK方式调用。具体信息，请参见文档审核增强版接入指南。

提交审核任务

接口说明

• 业务接口：FileModeration，文档仅提供异步检测接口。

• 支持的地域及接入地址：

  地域	外网接入地址	内网接入地址	支持的服务
  华东2（上海）	green-cip.cn-shanghai.aliyuncs.com	green-cip-vpc.cn-shanghai.aliyuncs.com	document_detection
  华北2（北京）	green-cip.cn-beijing.aliyuncs.com	green-cip-vpc.cn-beijing.aliyuncs.com
  华东1（杭州）	green-cip.cn-hangzhou.aliyuncs.com	green-cip-vpc.cn-hangzhou.aliyuncs.com

• 计费信息：

  该接口为收费接口，会根据检测文档页数计费。

• 检测对象：支持检测常见文档。

• 返回结果：异步检测任务不会实时返回检测结果，您需要通过callback或者轮询的方式获取检测结果。检测结果最长保留24小时。

  • callback获取检测结果：提交异步检测任务时，在请求参数中传入callback参数，用来自动接收检测结果。

  • 轮询获取检测结果：提交异步检测任务时，无需传入callback参数；提交异步检测任务后，调用结果查询接口获取检测结果。

• 文档要求：

  • 文档链接支持以下协议：HTTP和HTTPS。

  • 文档支持以下格式：DOC、DOCX、PPT、PPTX、PPS、PPSX、PDF、XLS、XLSX、XLTX、XLTM。

  • 文档大小限制：单个文档不超过200 MB。如果超过200 MB，需要对文档进行压缩或拆分处理。

  • 文档检测的时间依赖于文档的下载时间。请保证被检测的文档所在的存储服务稳定可靠，建议您使用阿里云OSS存储服务存储文档。

• 检测规则配置：

  • 初次调用时请在内容安全控制台进行文档审核规则设置。如果您不设置，文档审核增强版API会采用默认配置。

QPS限制

本接口的单用户QPS限制为100次/秒，并发审核路数限制为20路（即同一时间只能处理20个任务）。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

在接入前，您也可以通过阿里云OpenAPI在线调试接口，查看调用示例代码及SDK依赖信息，方便概览接口的使用方法和参数。

请求参数

表1 ServiceParameters

返回数据

示例

请求示例

{
  "Service": "document_detection",
  "ServiceParameters":
  {
    "url": "http://www.aliyundoc.com/a.pdf",
    "dataId": "fileId****"
  }
}

正常返回示例

{
    "Msg": "OK",
    "Code": 200,
    "Data":
    {
        "TaskId": "AAAAA-BBBBB-CCCCCCCC"
    },
    "RequestId": "ABCD1234-1234-1234-1234-123****"
}

获取文档审核任务结果

接口说明

• 业务接口：DescribeFileModerationResult，表示获取文档审核任务结果。

• 计费信息：该接口不计费。

• 查询超时：建议您将查询间隔设置为30秒（即在提交异步检测任务30秒后查询结果），最长不能超出24小时，否则结果将会自动删除。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

在接入前，您也可以通过阿里云OpenAPI在线调试接口，查看调用示例代码及SDK依赖信息，方便概览接口的使用方法和参数。

请求参数

表1 ServiceParameters

返回数据

表2 Data

表3 PageResult

表4 ImageResult

表5 LabelResult

表6 TextResult

示例

请求示例

{
"service":"document_detection",
"serviceParameters":
  {
      "taskId":"abcd****"
  }
}

正常返回示例

{
	"code":200,
	"data":{
		"dataId":"fileId*****",
		"pageResult":[
			{
				"imageResult":[
					{
						"description":"对文档页面的图像内容审核",
						"labelResult":[
							{
								"label":"nonLabel"
							}
						],
						"service":"baselineCheck"
					}
				],
				"imageUrl":"http://oss.aliyundoc.com/a.png",
				"pageNum":1,
				"textResult":[
					{
						"description":"对文档页面的文字内容审核",
						"labels":"",
						"riskTips":"",
						"riskWords":"",
						"service":"pgc_detection",
						"text":"内容安全产品测试用例a"
					}
				]
			},
      ...
      {
				"imageResult":[
					{
						"description":"对文档页面的图像内容审核",
						"labelResult":[
							{
								"confidence":89.01,
								"label":"pornographic_adultContent_tii"
							}
						],
						"service":"baselineCheck"
					}
				],
				"imageUrl":"http://oss.aliyundoc.com/b.png",
				"pageNum":10,
				"textResult":[
					{
						"description":"对文档页面的文字内容审核",
						"labels":"contraband,sexual_content",
						"riskTips":"违禁_违禁商品,色情_影视资源,色情_低俗",
						"riskWords":"风险词A,风险词B",
						"service":"ad_compliance_detection",
						"text":"内容安全产品测试用例b"
					}
				]
			}
    ],
		"url":"http://www.aliyundoc.com/a.docx"
	},
	"message":"SUCCESS",
	"requestId":"1D0854A7-AAAAA-BBBBBBB-CC8292AE5"
}

Code说明

以下为文档审核增强版接口返回Code的含义说明，系统仅对Code返回为200和280的请求计量计费，其他Code不会计费。